<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>netmiko.cli_tools.netmiko_grep API documentation</title>
<meta name="description" content="Create grep like remote behavior on show run or command output." />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>netmiko.cli_tools.netmiko_grep</code></h1>
</header>
<section id="section-intro">
<p>Create grep like remote behavior on show run or command output.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#!/usr/bin/env python
&#34;&#34;&#34;Create grep like remote behavior on show run or command output.&#34;&#34;&#34;
from __future__ import print_function
from __future__ import unicode_literals

import argparse
import sys
import os
import subprocess
import threading

try:
    from Queue import Queue
except ImportError:
    from queue import Queue
from datetime import datetime
from getpass import getpass

from netmiko import ConnectHandler
from netmiko.utilities import load_devices, display_inventory
from netmiko.utilities import obtain_all_devices
from netmiko.utilities import obtain_netmiko_filename, write_tmp_file, ensure_dir_exists
from netmiko.utilities import find_netmiko_dir
from netmiko.utilities import SHOW_RUN_MAPPER

GREP = &#34;/bin/grep&#34;
if not os.path.exists(GREP):
    GREP = &#34;/usr/bin/grep&#34;
NETMIKO_BASE_DIR = &#34;~/.netmiko&#34;
ERROR_PATTERN = &#34;%%%failed%%%&#34;
__version__ = &#34;0.1.0&#34;


def grepx(files, pattern, grep_options, use_colors=True):
    &#34;&#34;&#34;Call system grep&#34;&#34;&#34;
    if not isinstance(files, (list, tuple)):
        files = [files]
    if use_colors:
        grep_options += [&#34;--color=auto&#34;]

    # Make grep output look nicer by &#39;cd netmiko_full_dir&#39;
    _, netmiko_full_dir = find_netmiko_dir()
    os.chdir(netmiko_full_dir)
    # Convert files to strip off the directory
    retrieve_file = lambda x: x.split(&#34;/&#34;)[-1]  # noqa
    files = [retrieve_file(a_file) for a_file in files]
    files.sort()
    grep_list = [GREP] + grep_options + [pattern] + files
    proc = subprocess.Popen(grep_list, shell=False)
    proc.communicate()
    return &#34;&#34;


def ssh_conn(device_name, a_device, cli_command, output_q):
    try:
        net_connect = ConnectHandler(**a_device)
        net_connect.enable()
        output = net_connect.send_command_expect(cli_command)
        net_connect.disconnect()
    except Exception:
        output = ERROR_PATTERN
    output_q.put({device_name: output})


def parse_arguments(args):
    &#34;&#34;&#34;Parse command-line arguments.&#34;&#34;&#34;
    description = &#34;Grep pattern search on Netmiko output (defaults to running-config)&#34;
    parser = argparse.ArgumentParser(description=description)
    parser.add_argument(
        &#34;pattern&#34;, nargs=&#34;?&#34;, help=&#34;Pattern to search for&#34;, action=&#34;store&#34;, type=str
    )
    parser.add_argument(
        &#34;devices&#34;,
        nargs=&#34;?&#34;,
        help=&#34;Device or group to connect to&#34;,
        action=&#34;store&#34;,
        type=str,
    )
    parser.add_argument(
        &#34;--cmd&#34;,
        help=&#34;Remote command to execute&#34;,
        action=&#34;store&#34;,
        default=None,
        type=str,
    )
    parser.add_argument(&#34;--username&#34;, help=&#34;Username&#34;, action=&#34;store&#34;, type=str)
    parser.add_argument(&#34;--password&#34;, help=&#34;Password&#34;, action=&#34;store_true&#34;)
    parser.add_argument(&#34;--secret&#34;, help=&#34;Enable Secret&#34;, action=&#34;store_true&#34;)
    parser.add_argument(&#34;--use-cache&#34;, help=&#34;Use cached files&#34;, action=&#34;store_true&#34;)
    parser.add_argument(
        &#34;--list-devices&#34;, help=&#34;List devices from inventory&#34;, action=&#34;store_true&#34;
    )
    parser.add_argument(
        &#34;--display-runtime&#34;, help=&#34;Display program runtime&#34;, action=&#34;store_true&#34;
    )
    parser.add_argument(
        &#34;--hide-failed&#34;, help=&#34;Hide failed devices&#34;, action=&#34;store_true&#34;
    )
    parser.add_argument(&#34;--version&#34;, help=&#34;Display version&#34;, action=&#34;store_true&#34;)
    cli_args = parser.parse_args(args)
    if not cli_args.list_devices and not cli_args.version:
        if not cli_args.devices or not cli_args.pattern:
            parser.error(&#34;Grep pattern or devices not specified.&#34;)
    return cli_args


def main_ep():
    sys.exit(main(sys.argv[1:]))


def main(args):
    start_time = datetime.now()
    cli_args = parse_arguments(args)

    cli_username = cli_args.username if cli_args.username else None
    cli_password = getpass() if cli_args.password else None
    cli_secret = getpass(&#34;Enable secret: &#34;) if cli_args.secret else None

    version = cli_args.version
    if version:
        print(&#34;netmiko-grep v{}&#34;.format(__version__))
        return 0
    list_devices = cli_args.list_devices
    if list_devices:
        my_devices = load_devices()
        display_inventory(my_devices)
        return 0

    cli_command = cli_args.cmd
    cmd_arg = False
    if cli_command:
        cmd_arg = True
    device_or_group = cli_args.devices.strip()
    pattern = cli_args.pattern
    use_cached_files = cli_args.use_cache
    hide_failed = cli_args.hide_failed

    output_q = Queue()
    my_devices = load_devices()
    if device_or_group == &#34;all&#34;:
        device_group = obtain_all_devices(my_devices)
    else:
        try:
            devicedict_or_group = my_devices[device_or_group]
            device_group = {}
            if isinstance(devicedict_or_group, list):
                for tmp_device_name in devicedict_or_group:
                    device_group[tmp_device_name] = my_devices[tmp_device_name]
            else:
                device_group[device_or_group] = devicedict_or_group
        except KeyError:
            return (
                &#34;Error reading from netmiko devices file.&#34;
                &#34; Device or group not found: {0}&#34;.format(device_or_group)
            )

    # Retrieve output from devices
    my_files = []
    failed_devices = []
    if not use_cached_files:
        for device_name, a_device in device_group.items():
            if cli_username:
                a_device[&#34;username&#34;] = cli_username
            if cli_password:
                a_device[&#34;password&#34;] = cli_password
            if cli_secret:
                a_device[&#34;secret&#34;] = cli_secret
            if not cmd_arg:
                cli_command = SHOW_RUN_MAPPER.get(a_device[&#34;device_type&#34;], &#34;show run&#34;)
            my_thread = threading.Thread(
                target=ssh_conn, args=(device_name, a_device, cli_command, output_q)
            )
            my_thread.start()
        # Make sure all threads have finished
        main_thread = threading.current_thread()
        for some_thread in threading.enumerate():
            if some_thread != main_thread:
                some_thread.join()
        # Write files
        while not output_q.empty():
            my_dict = output_q.get()
            netmiko_base_dir, netmiko_full_dir = find_netmiko_dir()
            ensure_dir_exists(netmiko_base_dir)
            ensure_dir_exists(netmiko_full_dir)
            for device_name, output in my_dict.items():
                file_name = write_tmp_file(device_name, output)
                if ERROR_PATTERN not in output:
                    my_files.append(file_name)
                else:
                    failed_devices.append(device_name)
    else:
        for device_name in device_group:
            file_name = obtain_netmiko_filename(device_name)
            try:
                with open(file_name) as f:
                    output = f.read()
            except IOError:
                return &#34;Some cache files are missing: unable to use --use-cache option.&#34;
            if ERROR_PATTERN not in output:
                my_files.append(file_name)
            else:
                failed_devices.append(device_name)

    grep_options = []
    grepx(my_files, pattern, grep_options)
    if cli_args.display_runtime:
        print(&#34;Total time: {0}&#34;.format(datetime.now() - start_time))

    if not hide_failed:
        if failed_devices:
            print(&#34;\n&#34;)
            print(&#34;-&#34; * 20)
            print(&#34;Failed devices:&#34;)
            failed_devices.sort()
            for device_name in failed_devices:
                print(&#34;  {}&#34;.format(device_name))
            print()
    return 0


if __name__ == &#34;__main__&#34;:
    sys.exit(main(sys.argv[1:]))</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="netmiko.cli_tools.netmiko_grep.grepx"><code class="name flex">
<span>def <span class="ident">grepx</span></span>(<span>files, pattern, grep_options, use_colors=True)</span>
</code></dt>
<dd>
<div class="desc"><p>Call system grep</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def grepx(files, pattern, grep_options, use_colors=True):
    &#34;&#34;&#34;Call system grep&#34;&#34;&#34;
    if not isinstance(files, (list, tuple)):
        files = [files]
    if use_colors:
        grep_options += [&#34;--color=auto&#34;]

    # Make grep output look nicer by &#39;cd netmiko_full_dir&#39;
    _, netmiko_full_dir = find_netmiko_dir()
    os.chdir(netmiko_full_dir)
    # Convert files to strip off the directory
    retrieve_file = lambda x: x.split(&#34;/&#34;)[-1]  # noqa
    files = [retrieve_file(a_file) for a_file in files]
    files.sort()
    grep_list = [GREP] + grep_options + [pattern] + files
    proc = subprocess.Popen(grep_list, shell=False)
    proc.communicate()
    return &#34;&#34;</code></pre>
</details>
</dd>
<dt id="netmiko.cli_tools.netmiko_grep.main"><code class="name flex">
<span>def <span class="ident">main</span></span>(<span>args)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def main(args):
    start_time = datetime.now()
    cli_args = parse_arguments(args)

    cli_username = cli_args.username if cli_args.username else None
    cli_password = getpass() if cli_args.password else None
    cli_secret = getpass(&#34;Enable secret: &#34;) if cli_args.secret else None

    version = cli_args.version
    if version:
        print(&#34;netmiko-grep v{}&#34;.format(__version__))
        return 0
    list_devices = cli_args.list_devices
    if list_devices:
        my_devices = load_devices()
        display_inventory(my_devices)
        return 0

    cli_command = cli_args.cmd
    cmd_arg = False
    if cli_command:
        cmd_arg = True
    device_or_group = cli_args.devices.strip()
    pattern = cli_args.pattern
    use_cached_files = cli_args.use_cache
    hide_failed = cli_args.hide_failed

    output_q = Queue()
    my_devices = load_devices()
    if device_or_group == &#34;all&#34;:
        device_group = obtain_all_devices(my_devices)
    else:
        try:
            devicedict_or_group = my_devices[device_or_group]
            device_group = {}
            if isinstance(devicedict_or_group, list):
                for tmp_device_name in devicedict_or_group:
                    device_group[tmp_device_name] = my_devices[tmp_device_name]
            else:
                device_group[device_or_group] = devicedict_or_group
        except KeyError:
            return (
                &#34;Error reading from netmiko devices file.&#34;
                &#34; Device or group not found: {0}&#34;.format(device_or_group)
            )

    # Retrieve output from devices
    my_files = []
    failed_devices = []
    if not use_cached_files:
        for device_name, a_device in device_group.items():
            if cli_username:
                a_device[&#34;username&#34;] = cli_username
            if cli_password:
                a_device[&#34;password&#34;] = cli_password
            if cli_secret:
                a_device[&#34;secret&#34;] = cli_secret
            if not cmd_arg:
                cli_command = SHOW_RUN_MAPPER.get(a_device[&#34;device_type&#34;], &#34;show run&#34;)
            my_thread = threading.Thread(
                target=ssh_conn, args=(device_name, a_device, cli_command, output_q)
            )
            my_thread.start()
        # Make sure all threads have finished
        main_thread = threading.current_thread()
        for some_thread in threading.enumerate():
            if some_thread != main_thread:
                some_thread.join()
        # Write files
        while not output_q.empty():
            my_dict = output_q.get()
            netmiko_base_dir, netmiko_full_dir = find_netmiko_dir()
            ensure_dir_exists(netmiko_base_dir)
            ensure_dir_exists(netmiko_full_dir)
            for device_name, output in my_dict.items():
                file_name = write_tmp_file(device_name, output)
                if ERROR_PATTERN not in output:
                    my_files.append(file_name)
                else:
                    failed_devices.append(device_name)
    else:
        for device_name in device_group:
            file_name = obtain_netmiko_filename(device_name)
            try:
                with open(file_name) as f:
                    output = f.read()
            except IOError:
                return &#34;Some cache files are missing: unable to use --use-cache option.&#34;
            if ERROR_PATTERN not in output:
                my_files.append(file_name)
            else:
                failed_devices.append(device_name)

    grep_options = []
    grepx(my_files, pattern, grep_options)
    if cli_args.display_runtime:
        print(&#34;Total time: {0}&#34;.format(datetime.now() - start_time))

    if not hide_failed:
        if failed_devices:
            print(&#34;\n&#34;)
            print(&#34;-&#34; * 20)
            print(&#34;Failed devices:&#34;)
            failed_devices.sort()
            for device_name in failed_devices:
                print(&#34;  {}&#34;.format(device_name))
            print()
    return 0</code></pre>
</details>
</dd>
<dt id="netmiko.cli_tools.netmiko_grep.main_ep"><code class="name flex">
<span>def <span class="ident">main_ep</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def main_ep():
    sys.exit(main(sys.argv[1:]))</code></pre>
</details>
</dd>
<dt id="netmiko.cli_tools.netmiko_grep.parse_arguments"><code class="name flex">
<span>def <span class="ident">parse_arguments</span></span>(<span>args)</span>
</code></dt>
<dd>
<div class="desc"><p>Parse command-line arguments.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def parse_arguments(args):
    &#34;&#34;&#34;Parse command-line arguments.&#34;&#34;&#34;
    description = &#34;Grep pattern search on Netmiko output (defaults to running-config)&#34;
    parser = argparse.ArgumentParser(description=description)
    parser.add_argument(
        &#34;pattern&#34;, nargs=&#34;?&#34;, help=&#34;Pattern to search for&#34;, action=&#34;store&#34;, type=str
    )
    parser.add_argument(
        &#34;devices&#34;,
        nargs=&#34;?&#34;,
        help=&#34;Device or group to connect to&#34;,
        action=&#34;store&#34;,
        type=str,
    )
    parser.add_argument(
        &#34;--cmd&#34;,
        help=&#34;Remote command to execute&#34;,
        action=&#34;store&#34;,
        default=None,
        type=str,
    )
    parser.add_argument(&#34;--username&#34;, help=&#34;Username&#34;, action=&#34;store&#34;, type=str)
    parser.add_argument(&#34;--password&#34;, help=&#34;Password&#34;, action=&#34;store_true&#34;)
    parser.add_argument(&#34;--secret&#34;, help=&#34;Enable Secret&#34;, action=&#34;store_true&#34;)
    parser.add_argument(&#34;--use-cache&#34;, help=&#34;Use cached files&#34;, action=&#34;store_true&#34;)
    parser.add_argument(
        &#34;--list-devices&#34;, help=&#34;List devices from inventory&#34;, action=&#34;store_true&#34;
    )
    parser.add_argument(
        &#34;--display-runtime&#34;, help=&#34;Display program runtime&#34;, action=&#34;store_true&#34;
    )
    parser.add_argument(
        &#34;--hide-failed&#34;, help=&#34;Hide failed devices&#34;, action=&#34;store_true&#34;
    )
    parser.add_argument(&#34;--version&#34;, help=&#34;Display version&#34;, action=&#34;store_true&#34;)
    cli_args = parser.parse_args(args)
    if not cli_args.list_devices and not cli_args.version:
        if not cli_args.devices or not cli_args.pattern:
            parser.error(&#34;Grep pattern or devices not specified.&#34;)
    return cli_args</code></pre>
</details>
</dd>
<dt id="netmiko.cli_tools.netmiko_grep.ssh_conn"><code class="name flex">
<span>def <span class="ident">ssh_conn</span></span>(<span>device_name, a_device, cli_command, output_q)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def ssh_conn(device_name, a_device, cli_command, output_q):
    try:
        net_connect = ConnectHandler(**a_device)
        net_connect.enable()
        output = net_connect.send_command_expect(cli_command)
        net_connect.disconnect()
    except Exception:
        output = ERROR_PATTERN
    output_q.put({device_name: output})</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="netmiko.cli_tools" href="index.html">netmiko.cli_tools</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="netmiko.cli_tools.netmiko_grep.grepx" href="#netmiko.cli_tools.netmiko_grep.grepx">grepx</a></code></li>
<li><code><a title="netmiko.cli_tools.netmiko_grep.main" href="#netmiko.cli_tools.netmiko_grep.main">main</a></code></li>
<li><code><a title="netmiko.cli_tools.netmiko_grep.main_ep" href="#netmiko.cli_tools.netmiko_grep.main_ep">main_ep</a></code></li>
<li><code><a title="netmiko.cli_tools.netmiko_grep.parse_arguments" href="#netmiko.cli_tools.netmiko_grep.parse_arguments">parse_arguments</a></code></li>
<li><code><a title="netmiko.cli_tools.netmiko_grep.ssh_conn" href="#netmiko.cli_tools.netmiko_grep.ssh_conn">ssh_conn</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>